.TH "SquareTriangularGridManipulation" 3 "Wed Jun 20 2012" "Version 0.0.01" "Discontinuous Galerkin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SquareTriangularGridManipulation \- 
.SH SYNOPSIS
.br
.PP
.SS "Data Types"

.in +1c
.ti -1c
.RI "type \fBSquareTriangularGrid\fP"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "pure integer function \fBnumberOfElements\fP (this)"
.br
.RI "\fIReturn the number of elements of the grid'\&. \fP"
.ti -1c
.RI "pure function \fBnumberOfBoundaryElements\fP (this)"
.br
.RI "\fIReturn the number of Boundary Elements of the grid'\&. \fP"
.ti -1c
.RI "subroutine \fBSetGridData\fP (this, Lx, Ly, Nelx, Nely, Basex, Basey)"
.br
.RI "\fISet the dimensional data for the grid'\&. \fP"
.ti -1c
.RI "subroutine \fBGenerateStructuredGrid\fP (this)"
.br
.ti -1c
.RI "subroutine \fBGenerateNodes\fP (this)"
.br
.RI "\fIGenerate the Grid Points with a Rectangular-Regular aspect'\&. \fP"
.ti -1c
.RI "subroutine \fBGenerateElements\fP (this)"
.br
.RI "\fIGenerate the data structures for the elements of the region'\&. \fP"
.ti -1c
.RI "subroutine \fBGenerateNeighbours\fP (this)"
.br
.RI "\fIGenerate the Neighbours for the Elements on the Grid'\&. It does not include the Ghost Elements on the Boundary'\&. \fP"
.ti -1c
.RI "subroutine \fBGenerateBoundaryEdges\fP (this)"
.br
.ti -1c
.RI "function \fBGhostTriangle\fP (boundaryElement, sharedEdge)"
.br
.RI "\fIReturn A Ghost Boundary Element Without any Degrees-of-Freedom setted'\&. \fP"
.ti -1c
.RI "subroutine \fBSetGhostData_Convection\fP (Ghost, BoundaryElement, sharedEdge, convectionFactor, EnvironmentTemperature)"
.br
.RI "\fISet Data for Boundary 'Ghost' Triangle on the Heat Convection Boundary'\&. \fP"
.ti -1c
.RI "subroutine \fBSetGhostData_PrescribedTemperature\fP (Ghost, BoundaryElement, sharedEdge, Temperature)"
.br
.RI "\fISet Data for Boundary 'Ghost' Triangle on the prescribed Dirichlet Boundary'\&. \fP"
.ti -1c
.RI "pure real(kind=8) function, 
.br
parameter \fBMaximumError\fP (this)"
.br
.ti -1c
.RI "subroutine \fBStep\fP (this)"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "integer, parameter \fBnumberOfBoundaries\fP = 4"
.br
.ti -1c
.RI "integer, parameter \fBprescribedTemperatureBoundary\fP = 1"
.br
.ti -1c
.RI "integer, parameter \fBprescribedHeatFluxBoundary\fP = 2"
.br
.ti -1c
.RI "integer, parameter \fBconvectionBoundary\fP = 3"
.br
.ti -1c
.RI "real(kind=8), parameter \fBMaximumError\fP = 1\&.0d-6"
.br
.ti -1c
.RI "integer, parameter \fBMaxSteps\fP = 100000"
.br
.in -1c
.SH "Detailed Description"
.PP 
Definition at line 1 of file SquareTriangularGrid\&.f90'\&.
.SH "Member Function/Subroutine Documentation"
.PP 
.SS "subroutine SquareTriangularGridManipulation::GenerateBoundaryEdges (type(SquareGrid), intent(inout)this)"
.PP
Definition at line 222 of file SquareTriangularGrid\&.f90'\&.
.SS "subroutine SquareTriangularGridManipulation::GenerateElements (type(SquareGrid), intent(inout)this)"
.PP
Generate the data structures for the elements of the region'\&. \fBParameters:\fP
.RS 4
\fIthis\fP - The Grid data structure 
.RE
.PP

.PP
Definition at line 135 of file SquareTriangularGrid\&.f90'\&.
.SS "subroutine SquareTriangularGridManipulation::GenerateNeighbours (type(SquareGrid), intent(inout)this)"
.PP
Generate the Neighbours for the Elements on the Grid'\&. It does not include the Ghost Elements on the Boundary'\&. \fBParameters:\fP
.RS 4
\fIthis\fP - The Grid data structure 
.RE
.PP

.PP
Definition at line 193 of file SquareTriangularGrid\&.f90'\&.
.SS "subroutine SquareTriangularGridManipulation::GenerateNodes (type(\fBSquareTriangularGrid\fP), intent(inout)this)"
.PP
Generate the Grid Points with a Rectangular-Regular aspect'\&. \fBParameters:\fP
.RS 4
\fIthis\fP - The Grid data Structure 
.RE
.PP

.PP
Definition at line 107 of file SquareTriangularGrid\&.f90'\&.
.SS "subroutine SquareTriangularGridManipulation::GenerateStructuredGrid (type(\fBSquareTriangularGrid\fP), intent(inout)this)"
.PP
Definition at line 91 of file SquareTriangularGrid\&.f90'\&.
.SS "function SquareTriangularGridManipulation::GhostTriangle (type(TriangleElement), intent(in)boundaryElement, integer, dimension(2), intent(in)sharedEdge)"
.PP
Return A Ghost Boundary Element Without any Degrees-of-Freedom setted'\&. \fBParameters:\fP
.RS 4
\fIboundaryElement\fP - The Element which has the 
.br
\fIsharedEdge\fP - 
.RE
.PP
\fBReturns:\fP
.RS 4
Ghost - The Ghost Element Structure 
.RE
.PP

.PP
Definition at line 254 of file SquareTriangularGrid\&.f90'\&.
.SS "pure real(kind=8) function, parameter \fBSquareTriangularGridManipulation::MaximumError\fP (type(\fBSquareTriangularGrid\fP), intent(in)this)"
.PP
Definition at line 337 of file SquareTriangularGrid\&.f90'\&.
.SS "pure function SquareTriangularGridManipulation::numberOfBoundaryElements (type(\fBSquareTriangularGrid\fP), intent(in)this)"
.PP
Return the number of Boundary Elements of the grid'\&. \fBParameters:\fP
.RS 4
\fIthis\fP - The triangular square grid of the 
.RE
.PP
\fBReturns:\fP
.RS 4
n - the number of elements on the boundary 
.RE
.PP

.PP
Definition at line 53 of file SquareTriangularGrid\&.f90'\&.
.SS "pure integer function SquareTriangularGridManipulation::numberOfElements (type(\fBSquareTriangularGrid\fP), intent(in)this)"
.PP
Return the number of elements of the grid'\&. \fBParameters:\fP
.RS 4
\fIthis\fP - The triangular square grid of the 
.RE
.PP
\fBReturns:\fP
.RS 4
n - the number of elements 
.RE
.PP

.PP
Definition at line 40 of file SquareTriangularGrid\&.f90'\&.
.SS "subroutine SquareTriangularGridManipulation::SetGhostData_Convection (type(TriangleElement), intent(out)Ghost, type(TriangleElement), intent(in)BoundaryElement, integer, dimension(2)sharedEdge, real(kind=8), intent(in)convectionFactor, real(kind=8), intent(in)EnvironmentTemperature)"
.PP
Set Data for Boundary 'Ghost' Triangle on the Heat Convection Boundary'\&. \fBParameters:\fP
.RS 4
\fIGhost\fP - The Boundary 'Ghost' Triangle for the heat convection 
.br
\fIBoundaryElement\fP - The Triangle element on the boundary 
.br
\fIsharedEdge\fP - The Edge which is shared with the elements 
.br
\fIconvectionFactor\fP - The convection heat coefficient 
.br
\fIEnvironmentTemperature\fP - The temperature of the external environment 
.RE
.PP

.PP
Definition at line 281 of file SquareTriangularGrid\&.f90'\&.
.SS "subroutine SquareTriangularGridManipulation::SetGhostData_PrescribedTemperature (type(TriangleElement), intent(out)Ghost, type(TriangleElement), intent(in)BoundaryElement, integer, dimension(2)sharedEdge, real(kind=8), dimension(2), intent(in)Temperature)"
.PP
Set Data for Boundary 'Ghost' Triangle on the prescribed Dirichlet Boundary'\&. \fBParameters:\fP
.RS 4
\fIGhost\fP - The Boundary 'Ghost' Triangle 
.br
\fIBoundaryElement\fP - The Triangle Element Adjacent to the Boundary 
.br
\fIsharedEdge\fP - The Edge which they share 
.br
\fITemperature\fP - The Temperature on the Boundary'\&. 
.RE
.PP

.PP
Definition at line 311 of file SquareTriangularGrid\&.f90'\&.
.SS "subroutine SquareTriangularGridManipulation::SetGridData (type(SquareGrid), intent(out)this, real(kind=8), intent(in)Lx, real(kind=8), intent(in)Ly, integer, intent(in)Nelx, integer, intent(in)Nely, real(kind=8), intent(in)Basex, real(kind=8), intent(in)Basey)"
.PP
Set the dimensional data for the grid'\&. \fBParameters:\fP
.RS 4
\fIthis\fP - The Grid data structure 
.br
\fILx\fP - The Length on the X Axis 
.br
\fILy\fP - The Length on the Y Axis 
.br
\fINelx\fP - The Number of elements over the X Axis 
.br
\fINely\fP - The Number of elements over the Y Axis 
.br
\fIBasex\fP - The Spatial Position of the Bottom-Leftest point on the X Axis 
.br
\fIBasey\fP - The Spatial Position of the Bottom-Leftest point on the Y Axis 
.RE
.PP

.PP
Definition at line 71 of file SquareTriangularGrid\&.f90'\&.
.SS "subroutine SquareTriangularGridManipulation::Step (type(\fBSquareTriangularGrid\fP), intent(out)this)"
.PP
Definition at line 351 of file SquareTriangularGrid\&.f90'\&.
.SH "Member Data Documentation"
.PP 
.SS "integer, parameter \fBSquareTriangularGridManipulation::convectionBoundary\fP = 3"
.PP
Definition at line 10 of file SquareTriangularGrid\&.f90'\&.
.SS "real(kind=8), parameter \fBSquareTriangularGridManipulation::MaximumError\fP = 1\&.0d-6"
.PP
Definition at line 12 of file SquareTriangularGrid\&.f90'\&.
.SS "integer, parameter \fBSquareTriangularGridManipulation::MaxSteps\fP = 100000"
.PP
Definition at line 14 of file SquareTriangularGrid\&.f90'\&.
.SS "integer, parameter \fBSquareTriangularGridManipulation::numberOfBoundaries\fP = 4"
.PP
Definition at line 6 of file SquareTriangularGrid\&.f90'\&.
.SS "integer, parameter \fBSquareTriangularGridManipulation::prescribedHeatFluxBoundary\fP = 2"
.PP
Definition at line 9 of file SquareTriangularGrid\&.f90'\&.
.SS "integer, parameter \fBSquareTriangularGridManipulation::prescribedTemperatureBoundary\fP = 1"
.PP
Definition at line 8 of file SquareTriangularGrid\&.f90'\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Discontinuous Galerkin from the source code'\&.
